home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / ftar_v1.arc / FTAR.DOC next >
Text File  |  1991-12-07  |  10KB  |  326 lines
  1.  
  2.  
  3.  
  4.             ██████████
  5.            ░██░░░░░░░
  6.            ░██████
  7.            ░██░░░░        ██████████
  8.            ░██           ░░░░░██░░░
  9.            ░██               ░██
  10.            ░░                ░██
  11.                              ░██
  12.                              ░██         █████████
  13.                              ░░         ░██░░░░░██
  14.                                         ░██     ██
  15.                                         ░█████████
  16.                                         ░██░░░░░██
  17.                                         ░██    ░██       ████████
  18.                                         ░░     ░░       ░██░░░░██
  19.                                                         ░██    ██
  20.                                                         ░██████░
  21.          Version 1.0                                    ░██░░░░██
  22.                                                         ░██   ░██
  23.                                                         ░░    ░░
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.              An AreaFix style notify message creator for Tosscan 1.0
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.                        Copyright 1991 -- C.B. Billingsley
  52.                                All Rights Reserved
  53.  
  54.  
  55.  
  56.  
  57.  
  58. Overview:
  59.  
  60. FTAR stands for Fred's Tosscan Area Reporter.
  61.  
  62. The purpose of this program is to allow Tosscan users to easily build a message 
  63. to tell points what echo areas they are taking, similar to AreaFix's NOTIFY 
  64. function. It is designed for hubs and bossnodes using Tosscan v 1.0.
  65.  
  66.  
  67.  
  68. Hardware requirements:
  69.  
  70. Since FTAR is designed to expressly use Tosscan v1.0, the hardware requirements 
  71. are the same as it. Although it may run on a different setup, this is not 
  72. recommended.
  73.  
  74.  
  75.  
  76. Disclaimer:
  77.  
  78. FTAR is not guaranteed to do anything on your system other than take up disk 
  79. space. The author will not be liable for any damages occurring from the use, 
  80. mis-use, or inability to use this software.
  81.  
  82. FTAR will attempt to make OPUS v1.03 style messages in your netmail directory. 
  83. These messages will be sent via your mailer to the nodes you are feeding. The 
  84. author cannot be held liable for abuse or mis-use of this program in cases of 
  85. FidoNet or other network policy violations.
  86.  
  87.  
  88.  
  89. Registration:
  90.  
  91. There are no registration fees or licensing agreements needed with FTAR as the 
  92. software is absolutely free. The author will retain the copyrights to the 
  93. program and freely allows distribution of it to anyone who has a need, 
  94. provided:
  95.  
  96.           The original archive remains intact and is not changed.
  97.           The date/stamp on the programs in the archive are not changed.
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.                                      Page 2
  107.  
  108.  
  109.  
  110.  
  111. Running FTAR:
  112.  
  113. FTAR is easy to use and setup. You first need to configure FTAR to your 
  114. system's needs and then all that is needed is to run FTAR when you want 
  115. messages sent.
  116.  
  117. FTAR takes several command line parameters, but will mostly operate on it's 
  118. configuration file named FTAR.CFG. The command line parameters are:
  119.  
  120. NOTIFY        - To have FTAR send out notification messages to the nodes
  121.                 you feed.
  122.  
  123. CONFIG        - To invoke the configuration section of FTAR.
  124.  
  125. /V            - Makes FTAR run in VERBOSE mode. FTAR will list each node
  126.                 and the number of echo areas they are taking to the screen
  127.                 so you may easily view it or redirect it to a log file.
  128.                 (this parameter is only available when using the NOTIFY
  129.                  command and will be ignored if used with another.)
  130.  
  131. /T            - Makes FTAR run in a TEST mode. Using this will cause FTAR
  132.                 not to send out messages. It will run through the whole
  133.                 NOTIFY procedure and do everything but send messages. You
  134.                 could use this with the /V parameter to get a quick list of
  135.                 nodes and how many areas they are taking.
  136.                 (this parameter is only available when using the NOTIFY
  137.                  command and will be ignored if used with another.)
  138.  
  139. /C=<filename> - Forces FTAR to use a different configuration file than
  140.                 FTAR.CFG. You can specify the full drive and pathname to
  141.                 the file as well.
  142.  
  143. /?            - Gives a short help screen with copyright date and information
  144.                 on these commands.
  145.  
  146. Configuration:
  147.  
  148. Use FTAR CONFIG to invoke the configuration screen. You will need to setup your 
  149. main FidoNet address, AKA's, and HUBs you connect to. Movement through the 
  150. configuration screen is done using your cursor keys and the enter key. When you 
  151. want to change a particular field, you move the cursor to that field and start 
  152. entering the data. When you are finished entering the data for that field, hit 
  153. [ENTER], or one of the movement keys, and the entry will be kept. To abort 
  154. editing a particular entry, you may hit [ESC] and the field will retain it's 
  155. original data.
  156.  
  157.  
  158.  
  159.  
  160.                                      Page 3
  161.  
  162.  
  163.  
  164.  
  165. Here is an explanation of the configuration entries:
  166.  
  167. Path to Tosscan Files
  168. ---------------------
  169.  
  170. Enter the drive and path to where Tosscan keeps it's 'AREAFILE.FD' and 
  171. 'NODEFILE.FD'. FTAR will use those files while it runs. Do not toss or scan for 
  172. mail while Fred is active. It does not share the files when Tosscan wants them.
  173.  
  174. EXAMPLE:       C:\FD\
  175.  
  176.  
  177. Path to NetMail Directory
  178. -------------------------
  179.  
  180. Enter the drive and path name to where your mailer keeps it's netmail messages. 
  181.  
  182. Currently FTAR only supports *.MSG netmail in the OPUS v1.03 format. (FIDO 
  183. format will be in another version. This one is OPUS v1.03 only).
  184.  
  185. EXAMPLE:       C:\FD\NETMAIL\
  186.  
  187.  
  188. Main Address and AKA's
  189. ----------------------
  190.  
  191. This is where you would put your main system address. Currently this is treated 
  192. like any other AKA, but may change in the future. You must enter the data using 
  193. the full 4d address including zone and point address. FTAR will use the 
  194. information put here to match up to partial addresses listed in the AKA or HUB 
  195. listings.
  196.  
  197. EXAMPLE:       1:147/26.0
  198.               69:1432/1.0
  199.  
  200. Enter all the addresses you use to toss mail to other nodes. The reporter 
  201. program will match the zone of the point or node to the first zone in your AKA 
  202. list, so only one address per zone, please. If you have two entries with the 
  203. same zone number, the first one will get matched and the second will never be 
  204. used.
  205.  
  206. Don't add erroneous AKA's. In other words, if the address doesn't hub mail then 
  207. you won't need it. Leaving the blank addresses as zone zero will decrease 
  208. overhead to the program and speed up your processing.
  209.  
  210. To delete an AKA simply enter a zero and hit return. ANY address with a zone 
  211. beginning with zero will be deleted.
  212.  
  213.  
  214.                                      Page 4
  215.  
  216.  
  217.  
  218.  
  219. HUB Addresses
  220. -------------
  221.  
  222. Enter the addresses of the system you are getting the echoes from. This is to 
  223. make sure they don't receive any of Fred's messages. Additionally, you may 
  224. include addresses of any node you don't wish to receive a message from Fred. 
  225. This can be your own Point number or any other address listed in Tosscan's 
  226. 'NODEFILE.FD'.
  227.  
  228. EXAMPLE:       1:147/11.0
  229.               1:363/320.0
  230.  
  231. As with AKAs, to delete a hub entry simply enter a zero as the zone and it will 
  232. be deleted. ANY address with a zone beginning with zero will be deleted. 
  233. Entering a partial address in either the AKA or HUB fields will be matched up 
  234. with the information in your main address. In other words, if your main address 
  235. is 1:147/26.0 and you enter 39 as one of your hubs then the address will be 
  236. entered as 1:147/39.0. Point numbers are always assumed to be zero unless 
  237. specified.
  238.  
  239.  
  240. Reporter
  241. --------
  242.  
  243. Entering FTAR with the NOTIFY parameter will invoke the reporter program. FTAR 
  244. will then look for the FTAR.CFG file in the current directory (unless you 
  245. specified differently on the command line). If it doesn't find it, it will exit 
  246. with notification of the error.
  247.  
  248. Once FTAR is started it will read your 'NODEFILE.FD' and 'AREAFILE.FD' and 
  249. begin to send a notification message telling each node what echos they are 
  250. taking.
  251.  
  252. The messages may be customized by using a text editor to create a file named 
  253. FTAR.MSG (a sample one has been provided in this archive). It may contain any 
  254. amount of text you wish, but I suggest you keep it short. This text file will 
  255. be placed at the beginning of the message before the names of the echos are 
  256. listed out.
  257.  
  258. You may use a [CTRL]-T in your text file to have FTAR insert the address the 
  259. message is coming from in your message. So, if the message is coming from your 
  260. first AKA of 69:1432/1, then [CTRL]-T in the FTAR.MSG will be replaced by your 
  261. 69:1432/1 address.
  262.  
  263. The sample message file will have an example of such a message.
  264.  
  265.  
  266.  
  267.  
  268.                                      Page 5
  269.  
  270.  
  271.  
  272.  
  273.  
  274. Limitations and assumptions
  275. ---------------------------
  276.  
  277. FTAR replaces a badly needed function in Tosscan 1.0, in my humble opinion, and 
  278. may not be needed, or function with later versions. FTAR was really written to 
  279. function on my system, so if the limitation of 5 AKA's and 10 hubs is a burden 
  280. in your setup, please let me know. It was certainly much more than I needed in 
  281. my configuration.
  282.  
  283. I have only been able to test FTAR using FrontDoor as the front end mailer. If 
  284. you are using Tosscan with another mailer and FTAR doesn't make compatible 
  285. messages for your system, then please let me know. 
  286.  
  287.  
  288.  
  289.  
  290. Comments and suggestions may be sent netmail to:
  291.  
  292. Cb Billingsley
  293.    FIDONET  1:147/26.0  or  ADULTLINKS  69:1432/1.0
  294.  
  295. or call my BBS  The M.I.S.E. Network @ (405)478-1144
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302. Many thanks go to:
  303.  
  304. Gary Blackburn and John Burton who helped me develop FTAR with their ideas.
  305.  
  306. Debby Brown for helping me with the documentation.
  307.  
  308. And to JoHo for making a great tosser/scanner. 
  309.  
  310.  
  311.  
  312.  
  313. Tosscan 1.0 copyright 1989 by Joaquim H. Homrighausen
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.                                      Page 6
  323.  
  324.  
  325.  
  326.